home *** CD-ROM | disk | FTP | other *** search
/ Amiga News 95 / Amiga News 95.iso / dpat / dpat05 / termii / documentation / commandes.doc next >
Encoding:
Text File  |  1992-07-21  |  22.7 KB  |  547 lines
  1. Le 2 Juillet 1991
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                                     Term II
  13.  
  14.                                   version 1.1
  15.  
  16.                           (c) 1990,1991 - Eric GONTIER
  17.  
  18.                                   COMMANDES.doc
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.         INTRODUCTION :
  29.  
  30.  
  31.             Term II est utilisable par un système de commandes. Toutes  les
  32.             fonctions de Term II sont accessibles par des  commandes. Tout
  33.             est commande. Pour l'instant, Term II reconnait 90 commandes,
  34.             mais il devrait en avoir près d'une centaine très bientôt.
  35.  
  36.             Ce mécanisme de commandes est très important, car il a permis
  37.             de faire Term II indépendamment de son interface utilisateur.
  38.             Plusieurs propriétés en découlent immédiatement :
  39.  
  40.                 - Le fichier de configuration est un fichier de commandes.
  41.                 L'utilisateur peut le modifier très simplement avec un
  42.                 simple éditeur de texte.
  43.  
  44.                 - Les menus ne sont qu'une interface aux commandes. Deux
  45.                 sortes de menu sont proposés. Le premier est un menu court,
  46.                 qui ne propose que quelques options donnant accès à des
  47.                 requesters pour des sélections plus fines. Le deuxième est
  48.                 plus classique : il se compose de menus et de sous-menus,
  49.                 donnant ainsi l'accès immédiat à de nombreuses commandes.
  50.  
  51.                 - Dernier intéret,  et  non  des  moindres,  ces  fonctions
  52.                 sont appelables facilement depuis ARexx, ce qui  permet  de
  53.                 créer facilement des scripts, pour concevoir  des  automates
  54.                 de téléchargement par exemple. Un mécanisme puissant  pour
  55.                 faciliter l'écriture de ces  scripts  et  tirant  au  mieux
  56.                 parti des possibilités de ARexx est en cours d'élaboration.
  57.                 Une description préléminaire se  trouve  à  la  fin  de  ce
  58.                 document.
  59.  
  60.  
  61.             La suite de ce document décrit les commandes existantes dans la
  62.             version 1.0 avec leur syntaxe. Le lecteur se reportera au
  63.             fichier SCRIPTS.doc pour plus d'informations sur l'utilisation
  64.             de ces commandes dans l'écriture de scripts à l'aide de ARexx.
  65.  
  66.  
  67.  
  68.  
  69.         LES COMMANDES :
  70.  
  71.             about
  72.                 Cette commande affiche l'about du  programme : copyright,
  73.                 version, date, nom de l'utilisateur dans le cas d'une
  74.                 version enregistrée
  75.  
  76.             capture
  77.                 Cette commande affiche le tableau de bord pour la capture
  78.                 d'une connection. La capture est toujours ajoutée en fin de
  79.                 fichier. On ne risque donc pas d'écraser un fichier par
  80.                 erreur.
  81.  
  82.             capture_buffer taille
  83.                 Cette commande permet de fixer la taille du buffer de
  84.                 capture. Dès que le buffer est plein, Term II écrit le
  85.                 buffer dans le fichier de capture. Il n'est pas conseillé
  86.                 de prendre un buffer trop gros, car dans ce cas, il peut y
  87.                 avoir des temps morts gênants pendant l'écriture sur
  88.                 disque du buffer.
  89.  
  90.             capture_dir "directory"
  91.                 Cette commande permet de fixer le répertoire de capture par
  92.                 défaut. Ce directory n'est utilisé que quand on passe par
  93.                 le tableau de bord de capture. Si on utilise la commande
  94.                 capture_on, il faut dans ce cas donner un chemin d'accès
  95.                 complet.
  96.  
  97.             capture_off
  98.                 Stopper la capture et vide le buffer.
  99.  
  100.             capture_on "nom_de_fichier"
  101.                 Démarre la capture d'une connection. Le nom_de_fichier doit
  102.                 être un chemin d'accès complet. En particulier, le
  103.                 répertoire fixé avec la commande capture_dir n'est pas
  104.                 utilisée.
  105.  
  106.             capture_on_
  107.                 Démarre la capture. Un requester s'affiche pour saisir le
  108.                 nom du fichier dans lequel devra être stocké la capture.
  109.                 Dans ce cas, le répertoire de capture, fixé avec la
  110.                 commande capture_dir, est utilisé.
  111.  
  112.  
  113.             console_autowrap_off
  114.                 Cette commande met la console en mode sans autowrap. Term
  115.                 II ne passera pas à la ligne automatiquement si la ligne
  116.                 est plus grande que l'écran, est une partie du texte peut
  117.                 ne pas êtrelisible.
  118.  
  119.             console_autowrap_on
  120.                 Cette commande met la console en mode autowrap. Dans ce
  121.                 cas, si Term II reçoit une ligne plus grande que l'écran,
  122.                 Term II passe à la ligne automatiquement, permettant ainsi
  123.                 de voir tout le texte.
  124.  
  125.             console_clear
  126.                 Efface la fenêtre
  127.  
  128.             console_close
  129.                 Ferme la fenêtre. Les caractères passant à travers
  130.                 l'interface série ne  sont  plus  affichés.  Mais Term II
  131.                 continue à fonctionner. Ce mode de fonctionnement est
  132.                 intéressant pour les connections en aveugle, par des
  133.                 scripts. On gagne du temps en ne faisant pas afficher la
  134.                 connection, mais on ne sait pas exactement ce qui se passe.
  135.                 Si la console est fermée, le seule moyen pour envoyer du
  136.                 texte est d'utiliser la commande serial_send.
  137.  
  138.             console_command
  139.                 Ouvre le requester avec la plupart des commandes liées à la
  140.                 commande, modifiables par gadgets.
  141.  
  142.             console_echo_off
  143.                 Arrete l'écho systématique.
  144.  
  145.             console_echo_on
  146.                 Mise en place de l'écho systématique. Tout caractère tapé
  147.                 est affiché à l'écran avant d'être envoyé sur l'interface
  148.                 série.
  149.  
  150.             console_font "nom.font" size
  151.                 Cette commande permet de changer la fonte utilisée par la
  152.                 fenêtre. Malheureusement, une limitation du console.device
  153.                 de l'Amiga empêche l'utilisation de fontes non
  154.                 proportionnelles.
  155.  
  156.             console_map_key numero "commande"
  157.                 Cette commande permet d'associer une commande à une touche
  158.                 de fonction. Les numéros 1 à 10 correspondent aux touches
  159.                 F1 à F10. Les numéros 11 à 20 correspondent aux touche
  160.                 <shift>F1 à <shift>F10. Par exemple :
  161.  
  162.                     console_map_key 1 "serial_send \"ATDT3600\n\""
  163.  
  164.                 associe la commande serial_send "ATDT3600\n" a la touche de
  165.                 fonction F1. Le caractère \ permet de définir des
  166.                 caractères spéciaux : \n correspond au RETURN (x0d) et \l
  167.                 au LINE FEED (x0a). \\ et \" permettent d'insérer les
  168.                 caractères \ et " respectivement, dans une chaine de
  169.                 caractères.
  170.  
  171.                 Voici quelques exemples d'assignation des touches de
  172.                 fonction, tel qu'on peut les trouver dans term.config :
  173.  
  174.                     #
  175.                     #   Exemples de programmation de touches de fonction
  176.                     #
  177.                     # shift-F10 pour quitter Term II
  178.                     console_map_key 20 "rexx \"quit.rexx\""
  179.                     # F10 pour lancer la XCMD Laser
  180.                     console_map_key 10 "rexx \"laser.rexx\""
  181.                     # F9 pour déconnecter un modem HAYES
  182.                     console_map_key 9 "serial_send \"+++\""
  183.                     # F1 pour appeler mon BBS favori
  184.                     console_map_key 1 "serial_send \"ATDT999999\n\""
  185.  
  186.  
  187.             console_open
  188.                 Ouvre une console, avec une fenêtre. Les options choisies
  189.                 avec les commandes window sont prises en compte pour
  190.                 choisir le nombre de couleurs, l'écran de travail, les
  191.                 gadgets de la fenêtre, etc...
  192.  
  193.             console_setfont
  194.                 Cette commande donne accès à un requester de fontes pour
  195.                 sélectionner une nouvelle fonte pour la console. Il est
  196.                 conseillé de n'utiliser que des fontes non
  197.                 proportionnelles.
  198.  
  199.             menu_long_on
  200.                 Met en place le menu long. C'est le menu avec le plus de
  201.                 sélections possibles.
  202.  
  203.             menu_off
  204.                 Retire le menu de la fenêtre.
  205.  
  206.             menu_short_on
  207.                 Met en place le menu court.
  208.  
  209.             option_load "nom_de_fichier"
  210.                 Lit et interprête un fichier de commandes. Au lancement,
  211.                 Term II exécute un option_load "term.config" pour
  212.                 s'auto-configurer.
  213.  
  214.             option_save "nom_de_fichier"
  215.                 Sauve toutes les paramètres de configuration sous forme
  216.                 d'un fichier de commandes. L'option "Save Config" du menu
  217.                 correspond à un option_save "term.config"
  218.  
  219.             panel
  220.                 Cette commande met en route la XCMD Panel qui permet de
  221.                 disposer d'un panneau de commandes : il suffit de cliquer
  222.                 sur un bouton pour lancer une exécution. Si le processus
  223.                 n'est pas déjà présent en mémoire, il est chargé puis créé.
  224.                 Pour plus d'informations sur cette XCMD, voir le fichier
  225.                 PANEL.doc
  226.  
  227.             phone_book
  228.                 Cette commande met en route la XCMD Phone Bool qui met en
  229.                 route un carnet de téléphone capable de composer
  230.                 automatiquement des numéros. Si le processus n'est pas déjà
  231.                 présent en mémoire, il est chargé puis créé. Pour plus
  232.                 d'informations sur cette XCMD, voir le fichier
  233.                 PHONE_BOOK.doc.
  234.  
  235.             quit
  236.                 Termine Term II, libérant du  même coup toutes les
  237.                 ressources acquises par Term au cours de son exécution. Si
  238.                 les XCMD Panel ou Phone Book ont été exécutées elles seront
  239.                 errêtées et retirées de la mémoire.
  240.  
  241.             rexx "nom_de_fichier"
  242.                 Cette commande permet de démarrer un script rexx (si
  243.                 RexxMaster est déjà en tâche de fond)
  244.  
  245.             rexx_delay delai
  246.                 Cette commande, utilisable uniquement depuis un script
  247.                 ARexx permet de mettre en attente le script, tandis que
  248.                 Term II continue à fonctionner normalement. Si le mécanisme
  249.                 de memory a été mis en route, la variable memory à
  250.                 l'intérieur du programme ARexx sera mise à jour (création
  251.                 si nécessaire). Voir aussi les commandes rexx_memory_on,
  252.                 rexx_memory_off et rexx_wait, ainsi que le fichier
  253.                 SCRIPTS.doc, pour plus d'informations. Il y a aussi
  254.                 plusieurs scripts d'exemple qui accompagnent Term II.
  255.  
  256.             rexx_memory_off
  257.                 Cette commande n'est utilisable que depuis un script Rexx.
  258.                 Elle permet d'arrêter le mécanisme de "memory".
  259.  
  260.             rexx_memory_on
  261.                 Cette  commande  n'est  utilisable qu'à l'intérieur d'un
  262.                 script ARexx. Elle permet de mettre en route le mécanisme
  263.                 de "memory". Ce mécanisme permet de se souvenir en
  264.                 permanence des 80 derniers caractères reçus par Term via
  265.                 l'interface série. Un programme ARexx pourra récupérer ces
  266.                 80 caractères dans la variable "memory" qui est créée
  267.                 automatiquement par Term. Cette variable est mise à jour à
  268.                 chaque appel aux fonctions rexx_delay ou rexx_wait. Le
  269.                 fichier SCRIPTS.doc donne des exemples d'utilisation de ces
  270.                 fonctions.
  271.  
  272.             rexx_wait delai1 delai2
  273.                 Cette commande n'est utilisable que depuis un script ARexx.
  274.                 Elle accepte deux valeurs de délai (en secondes) comme
  275.                 paramètre, donnant ainsi deux possibilités de retour dans
  276.                 le script. Le premier délai (délai1) permet de fixer un
  277.                 timeout pour l'arrivée du premier caractère attendu sur
  278.                 l'interface série. Le deuxième délai (délai2) permet de
  279.                 fixer un timeout sur le dernier caractère reçu. Si le
  280.                 mécanisme de "memory" a été mis en place, la variable
  281.                 "memory" sera mise à jour à l'intérieur du script appelant.
  282.                 Voir aussi le fichier SCRIPTS.doc et les commandes
  283.                 rexx_delay, rexx_memory_on, rexx_memory_off.
  284.  
  285.             serial
  286.                 Affiche le tableau de bord de l'interface série pour
  287.                 permettre de la paramétrer facilement, à la souris.
  288.  
  289.             serial_baud baud
  290.                 Fixe la vitesse de transmission sur l'interface série.
  291.  
  292.             serial_buffer taille
  293.                 Fixe la taille du buffer de l'interface série. Tout ce qui
  294.                 entre dans l'interface série est bufferisé par l'Amiga.
  295.                 Term II ne fait que lire dans ce buffer. A grande vitesse
  296.                 il est possible que Term II ne vide pas le buffer
  297.                 suffisamment vite. Dans ce cas, il peut être intéressant
  298.                 d'en augmenter la taille.
  299.  
  300.             serial_close
  301.                 Ferme le serial.device et libère les ressources associées.
  302.  
  303.             serial_length longueur
  304.                 Fixe la longueur des mots échangés  sur  le  serial.device.
  305.                 Les longueurs autorisées sont 7 bits ou 8 bits.
  306.  
  307.             serial_off
  308.                 Cette commande interdit à Term II de lire le serial.device.
  309.                 Cette commande peut-être utilisée dans les scripts ou dans
  310.                 les XCMD pour être sûr que Term II ne lit le serial device
  311.                 que sur demande. (par exemple avec xcmd_sread). Après un
  312.                 serial_off, Term ne pourra plus mettre à jour le buffer de
  313.                 memory utilisé dans les scripts et dans les XCMD.
  314.  
  315.             serial_on
  316.                 Cette commande à l'effet inverse de serial_off : elle
  317.                 autorise Term à lire le serial.device.
  318.  
  319.             serial_open "serial.device" unit
  320.                 Ouvre le serial.device. il faut spécifier le device utilisé
  321.                 ainsi que l'unit. En pratique, on utilise souvent le
  322.                 "serial.device" comme device, et 0 comme unit. Mais il est
  323.                 possible de prendre un autre device (carte modem interne,
  324.                 style  SUPRA  par  exemple), ou une autre unit (carte
  325.                 multisérie de Commodore)
  326.  
  327.             serial_parity parite
  328.                 Fixe la parité sur l'interface série. Trois sorte de
  329.                 parités sont autorisées : 0 impaire, 1 paire, 2 sans
  330.                 parité, 3 parité space, 4 parité mark.
  331.  
  332.             serial_send "chaine"
  333.                 Envoie la chaine de caractères dans l'interface série
  334.  
  335.  
  336.             serial_stop stop
  337.                 Fixe le nombre de bit de stops. Les valeurs autorisées sont
  338.                 1 ou 2.
  339.  
  340.             serial_xdisabled
  341.                 Empêche la gestion du handshake XON/XOFF par le serial
  342.                 device
  343.  
  344.             serial_xenabled
  345.                 Autorise la gestion du handshake XON/XOFF par le serial
  346.                 device.
  347.  
  348.             window_backdrop_off
  349.                 Indique que la fenetre ne devra pas être backdrop. Ne prend
  350.                 effet qu'au prochain console_open.
  351.  
  352.             window_backdrop_on
  353.                 Indique que la fenetre devra être backdrop. Ne prend effet
  354.                 qu'au prochain console_open.
  355.  
  356.             window_borderless_off
  357.                 Indique que la fenêtre devra être avec bords. Ne prend
  358.                 effet qu'au prochain console_open.
  359.  
  360.             window_borderless_on
  361.                 Indique que la fenêtre devra être sans bords. Ne prend
  362.                 effet qu'au prochain console_open.
  363.  
  364.             window_closegadget_off
  365.                 La fenêtre sera sans close gadget.
  366.  
  367.             window_closegadget_on
  368.                 La fenêtre aura un close gadget.
  369.  
  370.             window_color nombre
  371.                 Fixe le nombre de couleurs pour l'écran. Le nombre est 2, 4
  372.                 ou 8.
  373.  
  374.             window_dragbar_off
  375.                 La fenêtre n'aura pas de drag bar. On ne pourra donc pas la
  376.                 déplacer.
  377.  
  378.             window_dragbar_on
  379.                 La fenêtre aura une drag bar.
  380.  
  381.             window_options
  382.                 Affiche le tableau de bord des options pour la fenêtre.
  383.  
  384.             window_publicscreen_default
  385.                 Si on demande un public screen, alors Term II s'installera
  386.                 sur l'écran public par défaut.
  387.  
  388.             window_publicscreen_name "nom"
  389.                 Si on demande un écran public, Term II s'installera sur
  390.                 celui dont le nom est donné.
  391.  
  392.             window_screen_public
  393.                 Indique la fenetre devra  s'ouvrir  sur  un  écran  public.
  394.                 L'écran est désigné par une des options window_publicscreen
  395.  
  396.             window_screen_term
  397.                 Indique que Term II utilisera son propre écran.
  398.  
  399.             window_screen_workbench
  400.                 Indique que Term II utilisera le même écran que celui du
  401.                 Workbench.
  402.  
  403.             window_sizegadget_off
  404.                 Pas de size gadget pour la fenêtre.
  405.  
  406.             window_sizegadget_on
  407.                 Il y aura un size gadget à la fenêtre.
  408.  
  409.             window_termscreen_interlace_off
  410.                 Si Term  a  son  propre  écran  (window_screen_term),  Term
  411.                 n'utilisera pas un écran entrelacé.
  412.  
  413.             window_termscreen_interlace_on
  414.                 Si Term  a  son  propre  écran  (window_screen_term),  Term
  415.                 utilise un écran entrelacé.
  416.  
  417.             window_termscreen_shanghai_off
  418.                 Si Term a son propre écran, l'écran ne sera pas shanghai
  419.  
  420.             window_termscreen_shanghai_on
  421.                 Si Term a son propre écran, l'écran sera shanghai
  422.  
  423.             xcmd_delay
  424.                 Cette commande est l'équivalent de rexx_delay. Elle permet
  425.                 de faire un délai depuis une XCMD (voir le fichier
  426.                 XCMD.doc). xcmd_Args[0] est l'adresse d'un long contenant
  427.                 la valeur du délai en secondes. Cette commande ne peut être
  428.                 appelée que depuis un processus externe.
  429.  
  430.             xcmd_lock_request
  431.                 Cette commande demande à Term II de retourner un lock sur
  432.                 le répertoire de Term II, et un lock sur l'écran de Term
  433.                 II. Si besoin, l'écran sera ouvert par Term II. Cette
  434.                 commande est utile s'il pas prévu qu'une commande START
  435.                 soit transmise au processus externe. Le processus externe
  436.                 devra libérer ces locks lui-même avec les fonctions UnLock
  437.                 et UnlockPubScreen. Les valeurs des locks sont retournés en
  438.                 même temps que la XCMD, dans les champs xcmd_TermScreen et
  439.                 xcmd_TermDir. Cette commande ne peut-être appelée que
  440.                 depuis un processus externe.
  441.  
  442.             xcmd_memory_request
  443.                 Cette commande demande à Term II de retourner les 80
  444.                 derniers caractères reçus. C'est au processus externe de
  445.                 fournir un pointeur valide vers une chaine de 81 caractères
  446.                 (pour contenir le 0 de fin de chaine) dans laquelle Term II
  447.                 recopiera ces 80 caractères (plus le 0 de fin de chaine).
  448.                 Ce pointeur doit être placé dans le champ xcmd_Args[0] de
  449.                 la XCMD avant d'être envoyé à Term II. Cette commande ne
  450.                 peut être appelée que depuis un processus externe.
  451.  
  452.             xcmd_memory_off
  453.                 Equivalent de rexx_memory_off. Cette commande arrête le
  454.                 mécanisme de memory. Voir le fichier SCRIPTS.doc. Cette
  455.                 commande ne peut être appelée que depuis un processus
  456.                 externe.
  457.  
  458.             xcmd_memory_on
  459.                 Equivalent de rexx_memory_on, cette commande met en route
  460.                 le  mécanise de memory. Voir le fichier SCRIPTS.doc. Cette
  461.                 commande ne peut être appelée que depuis un processus
  462.                 externe.
  463.  
  464.             xcmd_setserial
  465.                 Commande spéciale pour les XCMD permettant de modifier les
  466.                 paramètres de l'interface série.
  467.  
  468.             xcmd_sflush
  469.                 Commande spéciale pour les XCMD permettant de vider les
  470.                 buffers de l'interface série.
  471.  
  472.             xcmd_squery
  473.                 Commande spéciale pour les XCMD permettant d'obtenir le
  474.                 nombre de caractères recus par l'interface série et en
  475.                 attente de lecture.
  476.  
  477.             xcmd_sread
  478.                 Commande spéciale pour les XCMD permettant de lire sur
  479.                 l'interface série. Voir le fichier SCRIPTS.doc
  480.  
  481.             xcmd_start "port"
  482.                 Cette commande émet un message XCMD_START vers le port d'un
  483.                 processus externe. Par exemple la commande
  484.  
  485.                     xcmd_start "PANEL_PORT"
  486.  
  487.                 permet de faire démarrer la maquette du panel.
  488.  
  489.             xcmd_stop "port"
  490.                 Envoie un message XCMD_STOP vers le port d'un  processus
  491.                 externe.
  492.  
  493.             xcmd_swrite
  494.                 Commande spéciale pour les XCMD permettant d'écrire sur
  495.                 l'interface série. Voir le fichier SCRIPTS.doc.
  496.  
  497.             xcmd_wait
  498.                 Equivalent de la commande rexx_wait. Voir le fichier
  499.                 SCRIPTS.doc. xcmd_Args[0] pointe sur un long contenant la
  500.                 valeur du premier délai en secondes. xmd_Args[1] pointe sur
  501.                 un long contenant la valeur du second délai, en secondes.
  502.                 Cette commande ne peut être appelée que depuis un processus
  503.                 externe.
  504.  
  505.             xpr
  506.                 Affiche le tableau de bord pour le téléchargement avec les
  507.                 protocoles XPR.
  508.  
  509.             xpr_close
  510.                 Ferme la librairie XPR ouverte.
  511.  
  512.             xpr_down_dir "directory"
  513.                 Fixe le répertoire de download.
  514.  
  515.             xpr_init "init"
  516.                 Envoie une chaine d'initialisation à un protocole XPR.
  517.                 Cette chaine dépend du protocole utilisé. Consulter la doc
  518.                 du protocole XPR utilisé.
  519.  
  520.             xpr_open "LibName"
  521.                 Ouvre une librairie XPR.
  522.  
  523.             xpr_open_
  524.                 Cette commande ouvre une librairie XPR. Un requester permet
  525.                 de saisir le nom de la librairie.
  526.  
  527.             xpr_receive "nom"
  528.                 Reçoit un fichier (download) par le protocole XPR
  529.                 sélectionné.
  530.  
  531.             xpr_receive_
  532.                 Cette commande permet de recevoir un fichier. Un  requester
  533.                 est utilisé pour saisir le nom du fichier.
  534.  
  535.             xpr_send "nom"
  536.                 Envoie un fichier (upload).
  537.  
  538.             xpr_send_
  539.                 Envoie un fichier. Utilise un requester pour saisir le  nom
  540.                 du fichier.
  541.  
  542.             xpr_setup
  543.                 Initialise un protocole XPR.
  544.  
  545.             xpr_up_dir "directory"
  546.                 Fixe le repertoire d'upload.
  547.